<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Module: ARHelper</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Module</strong></td>
          <td class="class-name-in-header">ARHelper</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../files/etl/util/ar_rb.html">
                etl/util/ar.rb
                </a>
        <br />
            </td>
        </tr>

        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">



   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000073">close_connection</a>&nbsp;&nbsp;
      <a href="#M000072">open_connection</a>&nbsp;&nbsp;
      <a href="#M000074">with_connection</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->
    <div id="includes">
      <h3 class="section-bar">Included Modules</h3>

      <div id="includes-list">
        <span class="include-name"><a href="Log.html">Log</a></span>
      </div>
    </div>

    <div id="section">





      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000073" class="method-detail">
        <a name="M000073"></a>

        <div class="method-heading">
          <a href="ARHelper.src/M000073.html" target="Code" class="method-signature"
            onclick="popupCode('ARHelper.src/M000073.html');return false;">
          <span class="method-name">close_connection</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Closes the database connection. This method can be safely invoked multiple
times.
</p>
        </div>
      </div>

      <div id="method-M000072" class="method-detail">
        <a name="M000072"></a>

        <div class="method-heading">
          <a href="ARHelper.src/M000072.html" target="Code" class="method-signature"
            onclick="popupCode('ARHelper.src/M000072.html');return false;">
          <span class="method-name">open_connection</span><span class="method-args">(params = {})</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Opens a connection to the database. It does not return it (if needed,
connections can be retrieved directly from <a
href="ActiveRecord.html">ActiveRecord</a> entries). This method reads
parameters both from arguments list and from the <tt>@props</tt> Hash.
Arguments list takes precedence. The relevant keys to be used as params are
<tt>adapter</tt>, <tt>host</tt> , <tt>username</tt> , <tt>password</tt> ,
<tt>database</tt> .
</p>
        </div>
      </div>

      <div id="method-M000074" class="method-detail">
        <a name="M000074"></a>

        <div class="method-heading">
          <a href="ARHelper.src/M000074.html" target="Code" class="method-signature"
            onclick="popupCode('ARHelper.src/M000074.html');return false;">
          <span class="method-name">with_connection</span><span class="method-args">(params={}) {|conn| ...}</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Executes the block passed as parameter with an open connection to the
database and closes it at the end of the blocks
</p>
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>